Skip to content

Fix README setup accuracy and improve section headers#97

Merged
extinctsion merged 1 commit intoextinctsion:masterfrom
calchiwo:improve-readme
Dec 23, 2025
Merged

Fix README setup accuracy and improve section headers#97
extinctsion merged 1 commit intoextinctsion:masterfrom
calchiwo:improve-readme

Conversation

@calchiwo
Copy link
Contributor

@calchiwo calchiwo commented Dec 23, 2025 •
edited by sourcery-ai bot
Loading

  • Removed the unittest installation step since unittest is part of the Python standard library.
  • Cleaned up README section headers by converting HTML headers to Markdown (##) for better rendering and consistency.

These changes improve correctness and readability for beginners.

Summary by Sourcery

Update README setup instructions and formatting for accuracy and clarity.

Documentation:

  • Remove the incorrect step instructing users to install the standard-library unittest package.
  • Standardize README section headers by replacing HTML headers with Markdown-style headers for consistent rendering.

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 23, 2025 •
edited
Loading

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates the README to correct an unnecessary unittest installation step and normalizes header formatting for better readability and consistency.

File-Level Changes

Change Details Files
Corrected setup instructions by removing the redundant unittest installation step from the README.
  • Deleted the numbered step that instructed users to install unittest separately.
  • Removed the associated pip install unittest shell snippet while keeping surrounding code block structure intact.
 README.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 23, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sourcery-ai[bot]
sourcery-ai bot reviewed Dec 23, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@extinctsion extinctsion added the documentation Improvements or additions to documentation label Dec 23, 2025
extinctsion
extinctsion approved these changes Dec 23, 2025
View reviewed changes
Copy link
Owner

@extinctsion extinctsion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@extinctsion extinctsion merged commit c4e5d19 into extinctsion:master Dec 23, 2025
12 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@extinctsion extinctsion extinctsion approved these changes

Assignees

@calchiwo calchiwo

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@calchiwo @extinctsion